feat(cli): custom ws headers support #1729
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
If you have any questions, you can refer to the Contributing Guide
What is the current behavior?
Currently, the MQTTX command-line tool does not allow customization of WebSocket headers when using WebSocket connections.
Issue Number
Example: #1722
What is the new behavior?
Added the ability to customize WebSocket headers through the
-wh
parameter in the command line. For example:Does this PR introduce a breaking change?
Specific Instructions
When reviewing this PR, please note the following:
-wh
parameters to ensure multiple headers are correctly added.Other information
This feature comes from user requests, allowing users to customize headers when using WebSocket connections, increasing connection flexibility. For example, users can add authentication information or other custom data.
It's important to note that this feature is only supported in the command-line tool running in a Node.js environment. Due to browser security restrictions, the Desktop and Web versions of MQTTX cannot modify WebSocket headers, and therefore cannot implement this feature. This is a known limitation, and detailed information can be found in the related discussion in the MQTT.js project: mqttjs/MQTT.js#856
This new feature will provide more connection options for command-line users, especially useful in WebSocket connection scenarios that require special authentication or custom headers.